port.h

Go to the documentation of this file.

// This is not part of WOLF
// clang-format off
//
// Adapted from Ceres Solver 2.2.0 (include/ceres/internal/port.h) so that WOLF autodiff does not
// require Ceres: namespace 'ceres' renamed to 'wolf::autodiff', and 'CERES_' macros and include
// guards renamed to 'WOLF_AUTODIFF_'. The original license follows.
//
// Ceres Solver - A fast non-linear least squares minimizer
// Copyright 2023 Google Inc. All rights reserved.
// http://ceres-solver.org/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
// * Neither the name of Google Inc. nor the names of its contributors may be
//   used to endorse or promote products derived from this software without
//   specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Author: keir@google.com (Keir Mierle)
 
#ifndef WOLF_AUTODIFF_PUBLIC_INTERNAL_PORT_H_
#define WOLF_AUTODIFF_PUBLIC_INTERNAL_PORT_H_
 
// A macro to mark a function/variable/class as deprecated.
// We use compiler specific attributes rather than the c++
// attribute because they do not mix well with each other.
#if defined(_MSC_VER)
#define WOLF_AUTODIFF_DEPRECATED_WITH_MSG(message) __declspec(deprecated(message))
#elif defined(__GNUC__)
#define WOLF_AUTODIFF_DEPRECATED_WITH_MSG(message) __attribute__((deprecated(message)))
#else
// In the worst case fall back to c++ attribute.
#define WOLF_AUTODIFF_DEPRECATED_WITH_MSG(message) [[deprecated(message)]]
#endif
 
#ifndef WOLF_AUTODIFF_GET_FLAG
#define WOLF_AUTODIFF_GET_FLAG(X) X
#endif
 
// Indicates whether C++20 is currently active
#ifndef WOLF_AUTODIFF_HAS_CPP20
#if __cplusplus >= 202002L || (defined(_MSVC_LANG) && _MSVC_LANG >= 202002L)
#define WOLF_AUTODIFF_HAS_CPP20
#endif  // __cplusplus >= 202002L || (defined(_MSVC_LANG) && _MSVC_LANG >=
        // 202002L)
#endif  // !defined(WOLF_AUTODIFF_HAS_CPP20)
 
// Prevents symbols from being substituted by the corresponding macro definition
// under the same name. For instance, min and max are defined as macros on
// Windows (unless NOMINMAX is defined) which causes compilation errors when
// defining or referencing symbols under the same name.
//
// To be robust in all cases particularly when NOMINMAX cannot be used, use this
// macro to annotate min/max declarations/definitions. Examples:
//
//   int max WOLF_AUTODIFF_PREVENT_MACRO_SUBSTITUTION();
//   min WOLF_AUTODIFF_PREVENT_MACRO_SUBSTITUTION(a, b);
//   max WOLF_AUTODIFF_PREVENT_MACRO_SUBSTITUTION(a, b);
//
// NOTE: In case the symbols for which the substitution must be prevented are
// used within another macro, the substitution must be inhibited using parens as
//
//   (std::numerical_limits<double>::max)()
//
// since the helper macro will not work here. Do not use this technique in
// general case, because it will prevent argument-dependent lookup (ADL).
//
#define WOLF_AUTODIFF_PREVENT_MACRO_SUBSTITUTION  // Yes, it's empty
 
// WOLF_AUTODIFF_DISABLE_DEPRECATED_WARNING and WOLF_AUTODIFF_RESTORE_DEPRECATED_WARNING allow
// to temporarily disable deprecation warnings
#if defined(_MSC_VER)
#define WOLF_AUTODIFF_DISABLE_DEPRECATED_WARNING \
  _Pragma("warning(push)") _Pragma("warning(disable : 4996)")
#define WOLF_AUTODIFF_RESTORE_DEPRECATED_WARNING _Pragma("warning(pop)")
#else  // defined(_MSC_VER)
#define WOLF_AUTODIFF_DISABLE_DEPRECATED_WARNING
#define WOLF_AUTODIFF_RESTORE_DEPRECATED_WARNING
#endif  // defined(_MSC_VER)
 
#endif  // WOLF_AUTODIFF_PUBLIC_INTERNAL_PORT_H_